Worklist/Items({SerialNumber})/Actions/Sleep

Performs the system action to sleep a task the amount of time specified for the worklist item matching the SerialNumber.

URI

{Service Root URI}/Worklist/Items({SerialNumber})/Actions/Sleep?{Query Options}
https://api.denallix.com:443/K2Services/REST.svc/Worklist/Items(19_10)/Actions/Sleep? duration=2002-10-10T12:00:00−05:00

Method

GET

Service Path Options

Required
• SerialNumber (String) – the serial number for the worklist item

Query Options

Required

• duration (String) – the amount of time to sleep the task based on the duration provided.  
  • Duration = (>0) – sleeps the item the amount of seconds specified
  • Duration = (0) – sleeps the item indefinitely
  • Duration = (<0, e.g. -1) – wakes the item
  • Duration = {DateTime} – sleeps the item until specified date time.  Standard DateTime with time zone is supported: http://www.w3.org/TR/xmlschema11-2/#dateTime.

Optional

• System Query Options
• Custom Query Options – by default processing will not be done synchronously.  Changing either the service configuration (web.config) or providing this query options can force synchronous processing.
  • synchronous (Boolean) – determines if the server starts performs this action synchronously

Return Type

Success/Failure